Skip to content

Add conversation_id to valid thread metadata keys - #5774

Open
Seán (seanderoiste) wants to merge 1 commit into
mainfrom
docs/threads-add-conversation-id
Open

Add conversation_id to valid thread metadata keys#5774
Seán (seanderoiste) wants to merge 1 commit into
mainfrom
docs/threads-add-conversation-id

Conversation

@seanderoiste

Copy link
Copy Markdown

Why

The tracer's ingest pipeline accepts three metadata keys as aliases for thread grouping, but the docs listed only two. As a result, users following the docs might not know that conversation_id is a valid alias, and users who already use conversation_id (a natural name for chat frameworks) might assume their threads are misconfigured when in fact they are grouping correctly.

Source of truth

smith-go/queue/ingest/prepare_run_payload.go:145:

```go
for _, k := range []string{"session_id", "conversation_id", "thread_id"} {
```

The ingest layer checks the three keys in this order and uses the first one present.

Change

src/langsmith/threads.mdx:

  • Added conversation_id to the bulleted list of valid keys.
  • Added a one-sentence note on the check order.
  • Updated the Warning callout to include conversation_id alongside session_id and thread_id.

Other pages that mention this list

Several other pages still list only session_id and thread_id. Left them out of this PR to keep the change focused, but flagging for follow-up:

  • `src/langsmith/export-traces.mdx`
  • `src/langsmith/annotation-queues.mdx`
  • `src/langsmith/cost-tracking.mdx`
  • `src/langsmith/query-threads.mdx`
  • `src/langsmith/trace-query-syntax.mdx`

Some of these may be intentionally two-key (query/filter side vs ingest side) — worth someone with more context looking.

AI involvement

Drafted with Claude Code. Change and PR description reviewed by human.

The tracer ingest pipeline accepts three keys as aliases for thread
grouping (session_id, conversation_id, thread_id), but the docs listed
only two. Add conversation_id and note the check order.

See smith-go/queue/ingest/prepare_run_payload.go:145 for the source of
truth.
@github-actions github-actions Bot added the langsmith For docs changes to LangSmith label Aug 30, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Thanks for opening a docs PR, Seán (@seanderoiste)! When it's ready for review, please add the relevant reviewers:

  • @fjmorris or @lnhsingh (LangSmith)

@github-actions

Copy link
Copy Markdown
Contributor

Mintlify preview branch generated: preview-docsth-1788110737-21a516d

Site preview: https://langchain-5e9cc07a-preview-docsth-1788110737-21a516d.mintlify.site

Important

Preview links may take a few minutes to start working while the deployment finishes.

Changed documentation pages (preview deep links):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal langsmith For docs changes to LangSmith

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant